Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec

Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec
Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec

The Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec schema encapsulates the NSX Container Plugin-specific cluster networking configuration parameters for the vSphere Namespaces Cluster Enable operation.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "pod_cidrs": [
        {
            "address": "string",
            "prefix": 0
        }
    ],
    "ingress_cidrs": [
        {
            "address": "string",
            "prefix": 0
        }
    ],
    "egress_cidrs": [
        {
            "address": "string",
            "prefix": 0
        }
    ],
    "cluster_distributed_switch": "string",
    "nsx_edge_cluster": "string",
    "nsx_tier0_gateway": "string",
    "namespace_subnet_prefix": 0,
    "routed_mode": false
}
pod_cidrs
Required

CIDR blocks from which Kubernetes allocates pod IP addresses. This range should not overlap with those in Vcenter NamespaceManagement Clusters EnableSpec.service_cidr, Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec.ingress_cidrs, Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec.egress_cidrs, or other services running in the datacenter. All Pod CIDR blocks must be of at least subnet size /23.

This property was added in vSphere API 7.0.0.0.

ingress_cidrs
Required

CIDR blocks from which NSX assigns IP addresses for Kubernetes Ingresses and Kubernetes Services of type LoadBalancer. These ranges should not overlap with those in Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec.pod_cidrs, Vcenter NamespaceManagement Clusters EnableSpec.service_cidr, Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec.egress_cidrs, or other services running in the datacenter.

This property was added in vSphere API 7.0.0.0.

egress_cidrs
Required

CIDR blocks from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs. These ranges should not overlap with those in Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec.pod_cidrs, Vcenter NamespaceManagement Clusters EnableSpec.service_cidr, Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec.ingress_cidrs, or other services running in the datacenter.

This property was added in vSphere API 7.0.0.0.

string
cluster_distributed_switch
Optional

vSphere Distributed Switch used to connect this cluster.

This property was added in vSphere API 7.0.0.0.

This field is required when configuring a cluster that uses NSX. If missing or null and using NSXe, the system will choose a suitable vSphere Distributed Switch.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: vSphereDistributedSwitch. When operations return a value of this schema as a response, the property will be an identifier for the resource type: vSphereDistributedSwitch.

string
nsx_edge_cluster
Optional

NSX Edge cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT.

This property was added in vSphere API 7.0.0.0.

This field is required when configuring a cluster that uses NSX. If missing or null and using NSXe, the system will choose a suitable NSX Edge cluster.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: NSXEdgeCluster. When operations return a value of this schema as a response, the property will be an identifier for the resource type: NSXEdgeCluster.

string
nsx_tier0_gateway
Optional

NSX Tier0 Gateway used for this Supervisor.

This property was added in vSphere API 7.0.2.0.

This field is required when configuring a cluster that uses NSX.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: NSXTier0Gateway. When operations return a value of this schema as a response, the property will be an identifier for the resource type: NSXTier0Gateway.

integer As int64 As int64
namespace_subnet_prefix
Optional

Size of the subnet reserved for namespaces segments.

This property was added in vSphere API 7.0.2.0.

If missing or null, defaults to 28.

boolean
routed_mode
Optional

Routed mode for this Supervisor. When set to True, the traffic in the cluster is not NATed. When this field is set to True, Vcenter NamespaceManagement Clusters NCPClusterNetworkEnableSpec.egress_cidrs is not allowed.

This property was added in vSphere API 7.0.2.0.

If missing or null, defaults to False.